Skip to content

[DOCS] Adds compatibility matrix to docs and readme #2458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 7 commits into from
Feb 23, 2024
Merged

[DOCS] Adds compatibility matrix to docs and readme #2458

merged 7 commits into from
Feb 23, 2024

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Feb 22, 2024 •
edited
Loading

Overview

This PR adds a compatibility matrix to the Overview section of the Python book and the repo readme. It also fixes the markup of the links at the top of the Installation page.

Preview

@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@szabosteve szabosteve requested a review from pquentin February 22, 2024 14:44
pquentin
pquentin reviewed Feb 23, 2024
View reviewed changes
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Should we also update https://github.com/elastic/elasticsearch-py/blob/main/docs/sphinx/index.rst#compatibility?

@szabosteve
Copy link
Contributor Author

Should we also update https://github.com/elastic/elasticsearch-py/blob/main/docs/sphinx/index.rst#compatibility?

Yes, definitely! Thank you for the heads-up! I updated via 625c6fb.

@szabosteve szabosteve requested a review from pquentin February 23, 2024 09:32
pquentin
pquentin reviewed Feb 23, 2024
View reviewed changes
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tables do not render correctly in reST:

According to https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#tables, you're missing the separation between the lines (+---+---+---+).

pquentin
pquentin reviewed Feb 23, 2024
View reviewed changes
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, can you please change the casing as below? elasticsearch-py isn't capitalized. Thanks and sorry for all the nitpicks.

@szabosteve
Copy link
Contributor Author

Thanks for all the work on this, @pquentin! BTW, tables are killing me.

pquentin
pquentin approved these changes Feb 23, 2024
View reviewed changes
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for iterating! LGTM.

@pquentin pquentin merged commit 44c5c69 into main Feb 23, 2024
@pquentin pquentin deleted the szabosteve/comp-matrix branch February 23, 2024 10:14
github-actions bot pushed a commit that referenced this pull request Feb 23, 2024
@szabosteve @pquentin @github-actions
[DOCS] Adds compatibility matrix to docs and readme (#2458)
6d7c97d 
Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit 44c5c69)
@github-actions github-actions bot mentioned this pull request Feb 23, 2024
Merged
github-actions bot pushed a commit that referenced this pull request Feb 23, 2024
@szabosteve @pquentin @github-actions
[DOCS] Adds compatibility matrix to docs and readme (#2458)
fa9535c 
Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit 44c5c69)
@github-actions github-actions bot mentioned this pull request Feb 23, 2024
Merged
pquentin pushed a commit that referenced this pull request Feb 23, 2024
@github-actions @szabosteve
[DOCS] Adds compatibility matrix to docs and readme (#2458) (#2459)
985b0fe 
Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit 44c5c69)

Co-authored-by: István Zoltán Szabó <[email protected]>
pquentin pushed a commit that referenced this pull request Feb 23, 2024
@github-actions @szabosteve
[DOCS] Adds compatibility matrix to docs and readme (#2458) (#2460)
685eb62 
Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit 44c5c69)

Co-authored-by: István Zoltán Szabó <[email protected]>
iuliaferoli pushed a commit to iuliaferoli/elasticsearch-py that referenced this pull request Mar 24, 2024
@szabosteve @pquentin @iuliaferoli
[DOCS] Adds compatibility matrix to docs and readme (elastic#2458)
d519a47 
Co-authored-by: Quentin Pradet <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pquentin pquentin pquentin approved these changes

Assignees
No one assigned
Labels
Area: Documentation backport 8.12 backport 8.13
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@szabosteve @pquentin